Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jupyter notebook basic example #1754

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Mecoli1219
Copy link

@Mecoli1219 Mecoli1219 commented Oct 18, 2024

@davidmirror-ops
Copy link
Contributor

@Mecoli1219 please check the failing docs build. Fixing it should be straightforward. Thank you!

Signed-off-by: Mecoli1219 <[email protected]>
@Mecoli1219
Copy link
Author

@davidmirror-ops I'd like to get your input on the categorization of this example. I'm considering whether it should be in tutorial, integration, or the current examples/basics/ directory. Given that it demonstrates fundamental Jupyter Notebook integration with Flyte, which location would be most appropriate?

```

```{image} https://img.shields.io/badge/Blog-Interactive-blue?style=for-the-badge
:target: https://hackmd.io/@1E0FEh2MS_OpXGUAjEFIOQ/ByTTT821Jl
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is going to change as the end goal is to host this post on flyte.org right?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, correct. However, if this is going to be moved into the basics folder, I don't think this README.md file is needed

@davidmirror-ops
Copy link
Contributor

@Mecoli1219 I think examples/basics is the best location as it's where most of users getting started look at, and we want to surface how this integration enables them to use a familiar tool with Flyte.
Thank you!

Signed-off-by: Mecoli1219 <[email protected]>
@Mecoli1219
Copy link
Author

@davidmirror-ops @samhita-alla Can you help me review this PR? Thanks

@samhita-alla
Copy link
Contributor

shouldn't this be updated in the flyte repo: https://github.com/flyteorg/flyte/tree/master/docs/user_guide/basics? @davidmirror-ops do you know?

@davidmirror-ops
Copy link
Contributor

@samhita-alla excellent question. Both rendering the notebook as-is on a page in the flyte repo or keeping it in flytesnacks seems to require enabling one of the supported Sphynx extensions.
I guess keeping it on flytesnacks maintains the approach of storing the examples on a dedicated repo, and one could reference it from the flyte repo using notebooks/<notebook_name>
@cosmicBboy @eapolinario what do you think?

@Mecoli1219
Copy link
Author

Mecoli1219 commented Nov 11, 2024

@samhita-alla Oh... I finally understand what you mean. I'll open a PR in the flyte repo that updates this example in the basics example directory.

@samhita-alla
Copy link
Contributor

@Mecoli1219 I think we want the example in the flytesnacks repo, but we may need to add the extension. If there's a way to get a preview URL, that'd be helpful. The preview URL link included in the checks doesn’t have the user guide, so it’s hard to confirm if the docs are rendering correctly.

@Mecoli1219
Copy link
Author

@samhita-alla I am not sure what we are expecting now. As far as I know, we are only adding the .ipynb example in the basics directory in flytesnacks. However, we should create a new page (perhaps a .md file) in the flyte repo, letting it render part of the code in the flytesnacks' .ipynb file. The concern now is that in the flyte repo, we didn't have a Github Actions to verify the newly created page, so I should somehow build the document locally and manually check the correctness of the page.

Does this align with what you were thinking?

@davidmirror-ops
Copy link
Contributor

@Mecoli1219 Agree with creating a new page on the basics section of the Flyte repo and reference this notebook from there. Conceptually, this is an extension of Flyteremote but considering how prominent can be for new users, having on the basics section looks like a good option to me. I think we are more inclined to use the MystNB extension to render the Notebook, though I'm not sure how/if to render specific cells interleaved byt regular text in the markdown. I'm sorry if this has caused confusion, this is the first notebook example we host afaict.

@Mecoli1219
Copy link
Author

Got it! Let me try it out. By the way, I think placing the interactive mode content in Flyte Fundamentals would be more appropriate for the context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants